Vcenter Vcha ConnectionSpec

The Vcenter Vcha ConnectionSpec schema contains information required to connect to a vCenter server. The connection to the vCenter server always uses the HTTPS protocol.

This schema was added in vSphere API 6.7.1.

JSON Example

{
    "hostname": "string",
    "port": 0,
    "ssl_thumbprint": "string",
    "ssl_certificate": "string",
    "username": "string",
    "password": "string"
}

string

hostname

Required

IP Address or DNS of the vCenter.

This property was added in vSphere API 6.7.1.

integer As int64 As int64

port

Optional

Port number.

This property was added in vSphere API 6.7.1.

If missing or null, port 443 will be used.

string

ssl_thumbprint

Optional

This property is deprecated as of vSphere API 9.0.0.0. this property is deprecated please use sslCertificate instead.

SHA1 hash of the server SSL certificate.

This property was added in vSphere API 6.7.1.

If missing or null, empty ssl thumbprint is assumed.

string

ssl_certificate

Optional

PEM-encoded server SSL certificate of vCenter. Note: sslThumbprint and sslCertificate parameters are mutually exclusive, and should never be used simultaneously.

This property was added in vSphere API 9.0.0.0.

If missing or null, empty ssl certificate is assumed.

string

username

Optional

Username to access the server.

This property was added in vSphere API 6.7.1.

This property is currently required. If missing or null, an error is returned. In the future, if this property is missing or null, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail.

string As password As password

password

Optional

Password for the specified user.

This property was added in vSphere API 6.7.1.

This property is currently required. If missing or null, an empty password is assumed. In the future, if this property is missing or null, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail.